home *** CD-ROM | disk | FTP | other *** search
/ MacWorld 2003 August / MW 8 2003 CD1.iso / Inside Macworld / Product News / gimp-1.2.4.sit / gimp-1.2.4 / devel-docs / libgimp / sgml / gimppalette.sgml < prev    next >
Encoding:
Text File  |  2003-05-20  |  9.2 KB  |  239 lines
  1. <refentry id="libgimp-gimppalette" revision="19 Jan 2001">
  2. <refmeta>
  3. <refentrytitle>gimppalette</refentrytitle>
  4. <manvolnum>3</manvolnum>
  5. <refmiscinfo>LIBGIMP Library</refmiscinfo>
  6. </refmeta>
  7.  
  8. <refnamediv>
  9. <refname>gimppalette</refname><refpurpose></refpurpose>
  10. </refnamediv>
  11.  
  12. <refsynopsisdiv><title>Synopsis</title>
  13. <synopsis>
  14.  
  15.  
  16.  
  17. <link linkend="gboolean">gboolean</link>    <link linkend="gimp-palette-get-foreground">gimp_palette_get_foreground</link>     (<link linkend="guchar">guchar</link> *red,
  18.                                              <link linkend="guchar">guchar</link> *green,
  19.                                              <link linkend="guchar">guchar</link> *blue);
  20. <link linkend="gboolean">gboolean</link>    <link linkend="gimp-palette-get-background">gimp_palette_get_background</link>     (<link linkend="guchar">guchar</link> *red,
  21.                                              <link linkend="guchar">guchar</link> *green,
  22.                                              <link linkend="guchar">guchar</link> *blue);
  23. <link linkend="gboolean">gboolean</link>    <link linkend="gimp-palette-set-foreground">gimp_palette_set_foreground</link>     (<link linkend="guchar">guchar</link> red,
  24.                                              <link linkend="guchar">guchar</link> green,
  25.                                              <link linkend="guchar">guchar</link> blue);
  26. <link linkend="gboolean">gboolean</link>    <link linkend="gimp-palette-set-background">gimp_palette_set_background</link>     (<link linkend="guchar">guchar</link> red,
  27.                                              <link linkend="guchar">guchar</link> green,
  28.                                              <link linkend="guchar">guchar</link> blue);
  29. <link linkend="gboolean">gboolean</link>    <link linkend="gimp-palette-set-default-colors">gimp_palette_set_default_colors</link> (void);
  30. <link linkend="gboolean">gboolean</link>    <link linkend="gimp-palette-swap-colors">gimp_palette_swap_colors</link>        (void);
  31. <link linkend="gboolean">gboolean</link>    <link linkend="gimp-palette-refresh">gimp_palette_refresh</link>            (void);
  32. </synopsis>
  33. </refsynopsisdiv>
  34.  
  35.  
  36.  
  37.  
  38.  
  39. <refsect1>
  40. <title>Description</title>
  41. <para>
  42.  
  43. </para>
  44. </refsect1>
  45.  
  46. <refsect1>
  47. <title>Details</title>
  48. <refsect2>
  49. <title><anchor id="gimp-palette-get-foreground">gimp_palette_get_foreground ()</title>
  50. <programlisting><link linkend="gboolean">gboolean</link>    gimp_palette_get_foreground     (<link linkend="guchar">guchar</link> *red,
  51.                                              <link linkend="guchar">guchar</link> *green,
  52.                                              <link linkend="guchar">guchar</link> *blue);</programlisting>
  53. <para>
  54. Get the current GIMP foreground color.
  55. </para>
  56. <para>
  57. This procedure retrieves the current GIMP foreground color. The
  58. foreground color is used in a variety of tools such as paint tools,
  59. blending, and bucket fill.</para>
  60. <para>
  61.  
  62. </para><informaltable pgwide=1 frame="none" role="params">
  63. <tgroup cols="2">
  64. <colspec colwidth="2*">
  65. <colspec colwidth="8*">
  66. <tbody>
  67. <row><entry align="right"><parameter>red</parameter> :</entry>
  68. <entry>
  69. </entry></row>
  70. <row><entry align="right"><parameter>green</parameter> :</entry>
  71. <entry>
  72. </entry></row>
  73. <row><entry align="right"><parameter>blue</parameter> :</entry>
  74. <entry> The foreground color.
  75. </entry></row>
  76. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
  77. </entry></row>
  78. </tbody></tgroup></informaltable></refsect2>
  79. <refsect2>
  80. <title><anchor id="gimp-palette-get-background">gimp_palette_get_background ()</title>
  81. <programlisting><link linkend="gboolean">gboolean</link>    gimp_palette_get_background     (<link linkend="guchar">guchar</link> *red,
  82.                                              <link linkend="guchar">guchar</link> *green,
  83.                                              <link linkend="guchar">guchar</link> *blue);</programlisting>
  84. <para>
  85. Get the current GIMP background color.
  86. </para>
  87. <para>
  88. This procedure retrieves the current GIMP background color. The
  89. background color is used in a variety of tools such as blending,
  90. erasing (with non-alpha images), and image filling.</para>
  91. <para>
  92.  
  93. </para><informaltable pgwide=1 frame="none" role="params">
  94. <tgroup cols="2">
  95. <colspec colwidth="2*">
  96. <colspec colwidth="8*">
  97. <tbody>
  98. <row><entry align="right"><parameter>red</parameter> :</entry>
  99. <entry>
  100. </entry></row>
  101. <row><entry align="right"><parameter>green</parameter> :</entry>
  102. <entry>
  103. </entry></row>
  104. <row><entry align="right"><parameter>blue</parameter> :</entry>
  105. <entry> The background color.
  106. </entry></row>
  107. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
  108. </entry></row>
  109. </tbody></tgroup></informaltable></refsect2>
  110. <refsect2>
  111. <title><anchor id="gimp-palette-set-foreground">gimp_palette_set_foreground ()</title>
  112. <programlisting><link linkend="gboolean">gboolean</link>    gimp_palette_set_foreground     (<link linkend="guchar">guchar</link> red,
  113.                                              <link linkend="guchar">guchar</link> green,
  114.                                              <link linkend="guchar">guchar</link> blue);</programlisting>
  115. <para>
  116. Set the current GIMP foreground color.
  117. </para>
  118. <para>
  119. This procedure sets the current GIMP foreground color. After this is
  120. set, operations which use foreground such as paint tools, blending,
  121. and bucket fill will use the new value.</para>
  122. <para>
  123.  
  124. </para><informaltable pgwide=1 frame="none" role="params">
  125. <tgroup cols="2">
  126. <colspec colwidth="2*">
  127. <colspec colwidth="8*">
  128. <tbody>
  129. <row><entry align="right"><parameter>red</parameter> :</entry>
  130. <entry>
  131. </entry></row>
  132. <row><entry align="right"><parameter>green</parameter> :</entry>
  133. <entry>
  134. </entry></row>
  135. <row><entry align="right"><parameter>blue</parameter> :</entry>
  136. <entry> The foreground color.
  137. </entry></row>
  138. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
  139. </entry></row>
  140. </tbody></tgroup></informaltable></refsect2>
  141. <refsect2>
  142. <title><anchor id="gimp-palette-set-background">gimp_palette_set_background ()</title>
  143. <programlisting><link linkend="gboolean">gboolean</link>    gimp_palette_set_background     (<link linkend="guchar">guchar</link> red,
  144.                                              <link linkend="guchar">guchar</link> green,
  145.                                              <link linkend="guchar">guchar</link> blue);</programlisting>
  146. <para>
  147. Set the current GIMP background color.
  148. </para>
  149. <para>
  150. This procedure sets the current GIMP background color. After this is
  151. set, operations which use background such as blending, filling
  152. images, clearing, and erasing (in non-alpha images) will use the new
  153. value.</para>
  154. <para>
  155.  
  156. </para><informaltable pgwide=1 frame="none" role="params">
  157. <tgroup cols="2">
  158. <colspec colwidth="2*">
  159. <colspec colwidth="8*">
  160. <tbody>
  161. <row><entry align="right"><parameter>red</parameter> :</entry>
  162. <entry>
  163. </entry></row>
  164. <row><entry align="right"><parameter>green</parameter> :</entry>
  165. <entry>
  166. </entry></row>
  167. <row><entry align="right"><parameter>blue</parameter> :</entry>
  168. <entry> The background color.
  169. </entry></row>
  170. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
  171. </entry></row>
  172. </tbody></tgroup></informaltable></refsect2>
  173. <refsect2>
  174. <title><anchor id="gimp-palette-set-default-colors">gimp_palette_set_default_colors ()</title>
  175. <programlisting><link linkend="gboolean">gboolean</link>    gimp_palette_set_default_colors (void);</programlisting>
  176. <para>
  177. Set the current GIMP foreground and background colors to black and
  178. white.
  179. </para>
  180. <para>
  181. This procedure sets the current GIMP foreground and background
  182. colors to their initial default values, black and white.</para>
  183. <para>
  184.  
  185. </para><informaltable pgwide=1 frame="none" role="params">
  186. <tgroup cols="2">
  187. <colspec colwidth="2*">
  188. <colspec colwidth="8*">
  189. <tbody>
  190. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
  191. </entry></row>
  192. </tbody></tgroup></informaltable></refsect2>
  193. <refsect2>
  194. <title><anchor id="gimp-palette-swap-colors">gimp_palette_swap_colors ()</title>
  195. <programlisting><link linkend="gboolean">gboolean</link>    gimp_palette_swap_colors        (void);</programlisting>
  196. <para>
  197. Swap the current GIMP foreground and background colors.
  198. </para>
  199. <para>
  200. This procedure swaps the current GIMP foreground and background
  201. colors, so that the new foreground color becomes the old background
  202. color and vice versa.</para>
  203. <para>
  204.  
  205. </para><informaltable pgwide=1 frame="none" role="params">
  206. <tgroup cols="2">
  207. <colspec colwidth="2*">
  208. <colspec colwidth="8*">
  209. <tbody>
  210. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
  211. </entry></row>
  212. </tbody></tgroup></informaltable></refsect2>
  213. <refsect2>
  214. <title><anchor id="gimp-palette-refresh">gimp_palette_refresh ()</title>
  215. <programlisting><link linkend="gboolean">gboolean</link>    gimp_palette_refresh            (void);</programlisting>
  216. <para>
  217. Refreshes current palettes.
  218. </para>
  219. <para>
  220. This procedure incorporates all palettes currently in the users
  221. palette path.</para>
  222. <para>
  223.  
  224. </para><informaltable pgwide=1 frame="none" role="params">
  225. <tgroup cols="2">
  226. <colspec colwidth="2*">
  227. <colspec colwidth="8*">
  228. <tbody>
  229. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
  230. </entry></row>
  231. </tbody></tgroup></informaltable></refsect2>
  232.  
  233. </refsect1>
  234.  
  235.  
  236.  
  237.  
  238. </refentry>
  239.